Summary
Inserts a description of the document path on its hierarchy location (breadcrums).
Category | AS Menu |
Version | 1.1 |
Complies with Xhtml 1.0 / 1.1 rules | Yes |
Supported server programming languages | C# Visual Basic.NET |
Output content type | inline |
When to use
This component is typically used to insert breadcrumbs information i.e. the logical
path to the current document.
The following shows a typical path information:
Categories/Industrials/Tools/Woodworking tools/Planes
Programming interface
Parameters
- IncludeRoot
- Always include top level document.
- IncludeIfNoChildren
- Include top level document if no children exists, otherwise omit the top level.
- Make the current document a link
- Choose wheather to make the current document a link or not, e. g. clickable or not (clicking the link will be the same as reloading the page).
- Separator
- Separator between levels (parent / child / grandchild...).
- UseRoot
- Use id of root document in querystring.
- EPT field for document
- The name of an EPT-field that contains the id of a document to use as the base of the tree. Available in presentation templates only. Use only if the current document is not a member of a hierarchy and you wish to display another hierarchy instead.
- DocumentID
- The id of a document to use as the base of the tree. Ignored if DefaultParentField is set and should be zero to use the current document or its root as base instead. Use only if the current document is not a member of a hierarchy and you wish to display another hiercy instead.
Remarks
While rendering, the component starts with the current document and navigates upwards through the tree of hierarchy. However if a document that is not available for the caller the operation stops at that point and not all documents are returned in the path.